Skip to content

GH-1895: Move quick reference link higher on landing page - #1896

Draft
ncoghlan wants to merge 1 commit into
python:mainfrom
ncoghlan:gh-1895-make-quick-reference-link-more-prominent
Draft

GH-1895: Move quick reference link higher on landing page#1896
ncoghlan wants to merge 1 commit into
python:mainfrom
ncoghlan:gh-1895-make-quick-reference-link-more-prominent

Conversation

@ncoghlan

Copy link
Copy Markdown
Contributor

Partially addresses GH-1895

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 CPython devguide | 🛠️ Build #34296278 | 📁 Comparing e7744ac against latest (261dc21)

  🔍 Preview build  

1 file changed
± index.html

@StanFromIreland

Copy link
Copy Markdown
Member

This partially reverts some of the work that @sirosen and I did when restructuring the landing page. I think we had a slightly different goal in mind at the time. We wanted to make the landing page friendlier and for it to provide a more complete introduction, rather than having people jump straight into the quick reference (which was originally at the very top of the page).

For contributors at sprints, jumping straight into the code may work well because they generally have a mentor around to help straighten out any issues. But for people trying to contribute on their own at home, I worry that the immediate jump into code made getting started seem quite difficult (I also got some feedback along these lines from some new contributors). I think it would be good to preserve some of that gentler introduction here.

@ncoghlan
ncoghlan marked this pull request as draft September 6, 2026 14:49
@ncoghlan

ncoghlan commented Sep 6, 2026

Copy link
Copy Markdown
Contributor Author

Ah, that makes sense - I did wonder about the origin of the current sequencing.

I've put this back to draft for now - I'd still like to move the quick reference link before the big table, but it doesn't need to be the very first thing in the section (and it definitely isn't an urgent change).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants